home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / catD / module_info.z / module_info
Encoding:
Text File  |  1998-10-30  |  7.2 KB  |  133 lines
  1.  
  2.  
  3.  
  4. mmmmoooodddduuuulllleeee____iiiinnnnffffoooo((((DDDD4444))))                                                mmmmoooodddduuuulllleeee____iiiinnnnffffoooo((((DDDD4444))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _mmmm_oooo_dddd_uuuu_llll_eeee______iiii_nnnn_ffff_oooo - STREAMS driver and module information structure
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_ssss_yyyy_ssss_////_tttt_yyyy_pppp_eeee_ssss_...._hhhh_>>>>
  13.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_ssss_yyyy_ssss_////_cccc_oooo_nnnn_ffff_...._hhhh_>>>>
  14.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_ssss_yyyy_ssss_////_ssss_tttt_rrrr_eeee_aaaa_mmmm_...._hhhh_>>>>
  15.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_ssss_yyyy_ssss_////_dddd_dddd_iiii_...._hhhh_>>>>
  16.  
  17. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      When a module or driver is declared, several identification and limit
  19.      values can be set.  These values are stored in the _mmmm_oooo_dddd_uuuu_llll_eeee______iiii_nnnn_ffff_oooo structure.
  20.      These values are used to initialize the module's or driver's queues when
  21.      they are created.
  22.  
  23. UUUUSSSSAAAAGGGGEEEE
  24.      After the initial declaration, the _mmmm_oooo_dddd_uuuu_llll_eeee______iiii_nnnn_ffff_oooo structure is intended to
  25.      be read-only.  However, the flow control limits (_mmmm_iiii______hhhh_iiii_wwww_aaaa_tttt and _mmmm_iiii______llll_oooo_wwww_aaaa_tttt)
  26.      and the packet size limits (_mmmm_iiii______mmmm_iiii_nnnn_pppp_ssss_zzzz and _mmmm_iiii______mmmm_aaaa_xxxx_pppp_ssss_zzzz) are copied to the
  27.      _qqqq_uuuu_eeee_uuuu_eeee(D4) structure, where they may be modified.
  28.  
  29.      There may be one _mmmm_oooo_dddd_uuuu_llll_eeee______iiii_nnnn_ffff_oooo structure per read and write queue, or the
  30.      driver or module may use the same _mmmm_oooo_dddd_uuuu_llll_eeee______iiii_nnnn_ffff_oooo structure for both the read
  31.      and write queues.
  32.  
  33.    SSSSttttrrrruuuuccccttttuuuurrrreeee DDDDeeeeffffiiiinnnniiiittttiiiioooonnnnssss
  34.      The _mmmm_oooo_dddd_uuuu_llll_eeee______iiii_nnnn_ffff_oooo structure contains the following members:
  35.  
  36.      _uuuu_ssss_hhhh_oooo_rrrr_tttt______tttt  _mmmm_iiii______iiii_dddd_nnnn_uuuu_mmmm_;;;;    _////_**** _mmmm_oooo_dddd_uuuu_llll_eeee _IIII_DDDD _nnnn_uuuu_mmmm_bbbb_eeee_rrrr _****_////
  37.      _cccc_hhhh_aaaa_rrrr      _****_mmmm_iiii______iiii_dddd_nnnn_aaaa_mmmm_eeee_;;;;  _////_**** _mmmm_oooo_dddd_uuuu_llll_eeee _nnnn_aaaa_mmmm_eeee _****_////
  38.      _llll_oooo_nnnn_gggg      _mmmm_iiii______mmmm_iiii_nnnn_pppp_ssss_zzzz_;;;;   _////_**** _mmmm_iiii_nnnn_iiii_mmmm_uuuu_mmmm _pppp_aaaa_cccc_kkkk_eeee_tttt _ssss_iiii_zzzz_eeee _****_////
  39.      _llll_oooo_nnnn_gggg      _mmmm_iiii______mmmm_aaaa_xxxx_pppp_ssss_zzzz_;;;;   _////_**** _mmmm_aaaa_xxxx_iiii_mmmm_uuuu_mmmm _pppp_aaaa_cccc_kkkk_eeee_tttt _ssss_iiii_zzzz_eeee _****_////
  40.      _uuuu_llll_oooo_nnnn_gggg______tttt   _mmmm_iiii______hhhh_iiii_wwww_aaaa_tttt_;;;;    _////_**** _hhhh_iiii_gggg_hhhh _wwww_aaaa_tttt_eeee_rrrr _mmmm_aaaa_rrrr_kkkk _****_////
  41.      _uuuu_llll_oooo_nnnn_gggg______tttt   _mmmm_iiii______llll_oooo_wwww_aaaa_tttt_;;;;    _////_**** _llll_oooo_wwww _wwww_aaaa_tttt_eeee_rrrr _mmmm_aaaa_rrrr_kkkk _****_////
  42.      The _mmmm_iiii______iiii_dddd_nnnn_uuuu_mmmm field is a unique identifier for the driver or module that
  43.      distinguishes the driver or module from the other drivers and modules in
  44.      the system.
  45.  
  46.      The _mmmm_iiii______iiii_dddd_nnnn_aaaa_mmmm_eeee field points to the driver or module name.  The constant
  47.      _FFFF_MMMM_NNNN_AAAA_MMMM_EEEE_SSSS_ZZZZ limits the length of the name, not including the terminating
  48.      _NNNN_UUUU_LLLL_LLLL.  It is currently set to eight characters.
  49.  
  50.      The _mmmm_iiii______mmmm_iiii_nnnn_pppp_ssss_zzzz field is the default minimum packet size for the driver or
  51.      module queues.  This is an advisory limit specifying the smallest message
  52.      that can be accepted by the driver or module.
  53.  
  54.      The _mmmm_iiii______mmmm_aaaa_xxxx_pppp_ssss_zzzz field is the default maximum packet size for the driver or
  55.      module queues.  This is an advisory limit specifying the largest message
  56.      that can be accepted by the driver or module.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. mmmmoooodddduuuulllleeee____iiiinnnnffffoooo((((DDDD4444))))                                                mmmmoooodddduuuulllleeee____iiiinnnnffffoooo((((DDDD4444))))
  71.  
  72.  
  73.  
  74.      The _mmmm_iiii______hhhh_iiii_wwww_aaaa_tttt field is the default high water mark for the driver or
  75.      module queues.  This specifies the number of bytes of data contained in
  76.      messages on the queue such that the queue is considered full and hence
  77.      flow-controlled.
  78.  
  79.      The _mmmm_iiii______llll_oooo_wwww_aaaa_tttt field is the default low water mark for the driver or module
  80.      queues.  This specifies the number of bytes of data contained in messages
  81.      on the queue such that the queue is no longer flow-controlled.
  82.  
  83. RRRREEEEFFFFEEEERRRREEEENNNNCCCCEEEESSSS
  84.      _qqqq_uuuu_eeee_uuuu_eeee(D4)
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.